Skip to content

WIP Quick doc#1608

Merged
Byron merged 38 commits intogitpython-developers:mainfrom
LeoDaCoda:quick_doc
Jul 20, 2023
Merged

WIP Quick doc#1608
Byron merged 38 commits intogitpython-developers:mainfrom
LeoDaCoda:quick_doc

Conversation

@LeoDaCoda
Copy link
Contributor

@LeoDaCoda LeoDaCoda commented Jul 10, 2023

Hey, this PR is in reference to an issue I raised. I would like to add a quick start guide to act as another resource for developers, I planned the guide to be mainly code snippets as opposed to a text based tutorial.

I finished all the code and section headers I planned to add to the quick doc. I still want to add a few short sentences to improve readability. The tutorials includes how to do basic repo operations like init, clone, add, commit and push. Also shows how to iterate through the trees and print a text file.

Where possible I tried to follow the conventions the regular tutorial followed (ie having the code snippets inside of the test file) but in some cases I had to add code directly to the RST (I did this to avoid having unnecessary print statements to the test suite).

This is my first PR so forgive me if I did not follow propper conventions. Look forward to your feedback, Thanks!

Loading
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants